FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package ihe.pcc.rsq#current (47 ms)

Package ihe.pcc.rsq
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://profiles.ihe.net/PCC/ReferralStatus/https://build.fhir.org/ig/IHE/PCC.SDOH.RSQ/CapabilityStatement-IHE.SDOH-RSQ.server.html
Url https://profiles.ihe.net/PCC/SDOH-RSQ/CapabilityStatement/IHE.SDOH-RSQ.serever
Version 0.0.1-current
Status active
Date 2024-06-14
Name IHE_Referral_Status_Provider
Title IHE Referral Status Provider
Experimental False
Realm uv
Authority ihe
Description CapabilityStatement for the Referral Status Provide Actor in the Patient Care Coordination Technical Framework Supplement PCC SDOH Referral Status Query. See https://profiles.ihe.net/PCC/TF/Volume1/ch-38.html. The IHE Profile text is Normative, this conformance resource is Informative. The Provider delivers the status of an existing SDOH Referral by responding to the query from the SDOH Referral Status Consumer based on the referral identifier. - The referral workflow and the various mechanisms on how the referral identifier is known to the consumer and the provider are out of scope. - The Provider shall support both entry points for the FHIR search, a `ServiceRequest` or a `Task` resource.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement IHE.SDOH-RSQ.server

IHE Referral Status Provider

  • Implementation Guide Version: 0.0.1-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-06-14
  • Published by: IHE Patient Care Coordination Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

The Referral Status Query Server provides the status of a previously accepted referral. The query is accomplished via FHIR Search against the ServiceRequest or Task resources. The choice of which resource is used depends on the architecture of the implementation.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
ServiceRequest yy_id, identifierTask:focus
Task yy_id, identifier

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
resolves
Interaction summary
  • Supports read, search-type.

Documentation

Using FHIR search on the ServiceRequest resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

The business identifier representing the referral identifier

 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
resolves
Interaction summary
  • Supports read, search-type.

Documentation

Using FHIR search on the Task resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

The business identifier representing the referral identifier

 

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "IHE.SDOH-RSQ.server",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement IHE.SDOH-RSQ.server</b></p><a name=\"IHE.SDOH-RSQ.server\"> </a><a name=\"hcIHE.SDOH-RSQ.server\"> </a><a name=\"IHE.SDOH-RSQ.server-en-US\"> </a><h2 id=\"title\">IHE Referral Status Provider</h2><ul><li>Implementation Guide Version: 0.0.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-06-14 </li><li>Published by: IHE Patient Care Coordination Technical Committee </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>The Referral Status Query Server provides the status of a previously accepted referral. The query is accomplished via FHIR Search against the ServiceRequest or Task resources.\nThe choice of which resource is used depends on the architecture of the implementation.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or <a href=\"http://www.hl7.org/fhir/smart-app-launch/\">SMART-app-launch</a></p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#ServiceRequest1-1\">ServiceRequest</a></td><td>�</td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier</td><td/><td><code>Task:focus</code></td><td/></tr><tr><td><a href=\"#Task1-2\">Task</a></td><td>�</td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, identifier</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ServiceRequest1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>ServiceRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Using FHIR search on the <code>ServiceRequest</code> resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>The business identifier representing the referral identifier</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Task1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Task</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/task.html\">Task</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>resolves</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Using FHIR search on the <code>Task</code> resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>The business identifier representing the referral identifier</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
  },
  "url" : "https://profiles.ihe.net/PCC/SDOH-RSQ/CapabilityStatement/IHE.SDOH-RSQ.serever",
  "version" : "0.0.1-current",
  "name" : "IHE_Referral_Status_Provider",
  "title" : "IHE Referral Status Provider",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-06-14",
  "publisher" : "IHE Patient Care Coordination Technical Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.ihe.net/ihe_domains/patient_care_coordination/"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "email",
          "value" : "pcc@ihe.net"
        }
      ]
    },
    {
      "name" : "IHE Patient Care Coordination Technical Committee",
      "telecom" : [
        {
          "system" : "email",
          "value" : "pcc@ihe.net"
        }
      ]
    }
  ],
  "description" : "CapabilityStatement for the Referral Status Provide Actor in the Patient Care Coordination Technical Framework Supplement PCC SDOH Referral Status Query. See https://profiles.ihe.net/PCC/TF/Volume1/ch-38.html. The IHE Profile text is Normative, this conformance resource is Informative. \n\nThe Provider delivers the status of an existing SDOH Referral by responding to the query from the SDOH Referral Status Consumer based on the referral identifier.\n- The referral workflow and the various mechanisms on how the referral identifier is known to the consumer and the provider are out of scope.\n- The Provider shall support both entry points for the FHIR search, a `ServiceRequest` or a `Task` resource.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The Referral Status Query Server provides the status of a previously accepted referral. The query is accomplished via FHIR Search against the ServiceRequest or Task resources. \nThe choice of which resource is used depends on the architecture of the implementation. ",
      "security" : {
        "description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "ServiceRequest",
          "documentation" : "Using FHIR search on the `ServiceRequest` resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "Task:focus"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "type" : "token",
              "documentation" : "Logical id of this artifact"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "type" : "token",
              "documentation" : "The business identifier representing the referral identifier"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Task",
          "documentation" : "Using FHIR search on the `Task` resource as part of transaction [PCC-Y6] allows to find out the status of an existing referral.",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "type" : "token",
              "documentation" : "Logical id of this artifact"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "type" : "token",
              "documentation" : "The business identifier representing the referral identifier"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "search-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.